GetTokenBalances

POST /rpc/Indexer/GetTokenBalances

GetTokenBalances

cURL

curl --request POST \
  --url https://amoy-indexer.sequence.app/rpc/Indexer/GetTokenBalances \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Key: <api-key>' \
  --data '
{
  "accountAddress": "<string>",
  "contractAddress": "<string>",
  "tokenID": "<string>",
  "includeMetadata": true,
  "metadataOptions": {
    "verifiedOnly": true,
    "unverifiedOnly": true,
    "includeContracts": [
      "<string>"
    ]
  },
  "includeCollectionTokens": true,
  "page": {
    "page": 123,
    "column": "<string>",
    "before": {},
    "after": {},
    "sort": [
      {
        "column": "<string>"
      }
    ],
    "pageSize": 123,
    "more": true
  }
}
'

import requests

url = "https://amoy-indexer.sequence.app/rpc/Indexer/GetTokenBalances"

payload = {
    "accountAddress": "<string>",
    "contractAddress": "<string>",
    "tokenID": "<string>",
    "includeMetadata": True,
    "metadataOptions": {
        "verifiedOnly": True,
        "unverifiedOnly": True,
        "includeContracts": ["<string>"]
    },
    "includeCollectionTokens": True,
    "page": {
        "page": 123,
        "column": "<string>",
        "before": {},
        "after": {},
        "sort": [{ "column": "<string>" }],
        "pageSize": 123,
        "more": True
    }
}
headers = {
    "X-Access-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Access-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountAddress: '<string>',
    contractAddress: '<string>',
    tokenID: '<string>',
    includeMetadata: true,
    metadataOptions: {verifiedOnly: true, unverifiedOnly: true, includeContracts: ['<string>']},
    includeCollectionTokens: true,
    page: {
      page: 123,
      column: '<string>',
      before: {},
      after: {},
      sort: [{column: '<string>'}],
      pageSize: 123,
      more: true
    }
  })
};

fetch('https://amoy-indexer.sequence.app/rpc/Indexer/GetTokenBalances', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://amoy-indexer.sequence.app/rpc/Indexer/GetTokenBalances",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accountAddress' => '<string>',
    'contractAddress' => '<string>',
    'tokenID' => '<string>',
    'includeMetadata' => true,
    'metadataOptions' => [
        'verifiedOnly' => true,
        'unverifiedOnly' => true,
        'includeContracts' => [
                '<string>'
        ]
    ],
    'includeCollectionTokens' => true,
    'page' => [
        'page' => 123,
        'column' => '<string>',
        'before' => [
                
        ],
        'after' => [
                
        ],
        'sort' => [
                [
                                'column' => '<string>'
                ]
        ],
        'pageSize' => 123,
        'more' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Access-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://amoy-indexer.sequence.app/rpc/Indexer/GetTokenBalances"

	payload := strings.NewReader("{\n  \"accountAddress\": \"<string>\",\n  \"contractAddress\": \"<string>\",\n  \"tokenID\": \"<string>\",\n  \"includeMetadata\": true,\n  \"metadataOptions\": {\n    \"verifiedOnly\": true,\n    \"unverifiedOnly\": true,\n    \"includeContracts\": [\n      \"<string>\"\n    ]\n  },\n  \"includeCollectionTokens\": true,\n  \"page\": {\n    \"page\": 123,\n    \"column\": \"<string>\",\n    \"before\": {},\n    \"after\": {},\n    \"sort\": [\n      {\n        \"column\": \"<string>\"\n      }\n    ],\n    \"pageSize\": 123,\n    \"more\": true\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Access-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://amoy-indexer.sequence.app/rpc/Indexer/GetTokenBalances")
  .header("X-Access-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountAddress\": \"<string>\",\n  \"contractAddress\": \"<string>\",\n  \"tokenID\": \"<string>\",\n  \"includeMetadata\": true,\n  \"metadataOptions\": {\n    \"verifiedOnly\": true,\n    \"unverifiedOnly\": true,\n    \"includeContracts\": [\n      \"<string>\"\n    ]\n  },\n  \"includeCollectionTokens\": true,\n  \"page\": {\n    \"page\": 123,\n    \"column\": \"<string>\",\n    \"before\": {},\n    \"after\": {},\n    \"sort\": [\n      {\n        \"column\": \"<string>\"\n      }\n    ],\n    \"pageSize\": 123,\n    \"more\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://amoy-indexer.sequence.app/rpc/Indexer/GetTokenBalances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Access-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accountAddress\": \"<string>\",\n  \"contractAddress\": \"<string>\",\n  \"tokenID\": \"<string>\",\n  \"includeMetadata\": true,\n  \"metadataOptions\": {\n    \"verifiedOnly\": true,\n    \"unverifiedOnly\": true,\n    \"includeContracts\": [\n      \"<string>\"\n    ]\n  },\n  \"includeCollectionTokens\": true,\n  \"page\": {\n    \"page\": 123,\n    \"column\": \"<string>\",\n    \"before\": {},\n    \"after\": {},\n    \"sort\": [\n      {\n        \"column\": \"<string>\"\n      }\n    ],\n    \"pageSize\": 123,\n    \"more\": true\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "page": {
    "page": 123,
    "column": "<string>",
    "before": {},
    "after": {},
    "sort": [
      {
        "column": "<string>"
      }
    ],
    "pageSize": 123,
    "more": true
  },
  "balances": [
    {
      "contractAddress": "<string>",
      "accountAddress": "<string>",
      "balance": "<string>",
      "blockHash": "<string>",
      "blockNumber": 123,
      "chainId": 123,
      "uniqueCollectibles": "<string>",
      "isSummary": true,
      "tokenID": "<string>",
      "contractInfo": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "type": "<string>",
        "symbol": "<string>",
        "logoURI": "<string>",
        "deployed": true,
        "bytecodeHash": "<string>",
        "extensions": {
          "link": "<string>",
          "description": "<string>",
          "ogImage": "<string>",
          "originChainId": 123,
          "originAddress": "<string>",
          "blacklist": true,
          "verified": true,
          "verifiedBy": "<string>",
          "featured": true
        },
        "contentHash": 123,
        "updatedAt": "<string>",
        "decimals": 123
      },
      "tokenMetadata": {
        "tokenId": "<string>",
        "name": "<string>",
        "attributes": [
          {}
        ],
        "description": "<string>",
        "image": "<string>",
        "video": "<string>",
        "audio": "<string>",
        "properties": {},
        "imageData": "<string>",
        "externalUrl": "<string>",
        "backgroundColor": "<string>",
        "animationUrl": "<string>",
        "decimals": 123,
        "updatedAt": "<string>",
        "assets": [
          {
            "id": 123,
            "collectionId": 123,
            "metadataField": "<string>",
            "tokenId": "<string>",
            "url": "<string>",
            "filename": "<string>",
            "filesize": 123,
            "mimeType": "<string>",
            "width": 123,
            "height": 123,
            "updatedAt": "<string>"
          }
        ]
      }
    }
  ]
}

{
  "error": "WebrpcEndpoint",
  "code": 0,
  "msg": "endpoint error",
  "status": 400,
  "cause": "<string>"
}

{
  "error": "WebrpcBadResponse",
  "code": -5,
  "msg": "bad response",
  "status": 500,
  "cause": "<string>"
}

Authorizations

X-Access-Key · string · header · required

Public project access key for authenticating requests obtained on Sequence Builder. Example Test Key: AQAAAAAAAEGvyZiWA9FMslYeG_yayXaHnSI

Body

application/json

accountAddress · string

contractAddress · string

tokenID · string

includeMetadata · boolean

metadataOptions · object

Show child attributes

includeCollectionTokens · boolean

page · object

Show child attributes

Response

200

application/json

OK

page · object

Show child attributes

balances · object[]

[]TokenBalance

Show child attributes